home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Games Collection 1 / software vault.zip / software vault / CDR03 / XP108.ZIP / XP.DOC < prev    next >
Text File  |  1993-09-22  |  11KB  |  239 lines
  1.                         X-Wing Editor PRO V1.08
  2.  
  3.   Welcome to XP, this is my first attempt at writing a game editor.  However
  4. so far I'm happy with the results; I've got a very simple interface, which
  5. uses the cursor, hot keys, ENTER, and ESC to navigate the entire interface.
  6.  
  7.  
  8.  
  9.                                 -= Files =-
  10.  
  11.                         XP.EXE    -  The Xwing Editor
  12.                         XP.DOC    -  This file (Documentation)
  13.                         XP.UPD    -  Revision and Future Enhancements List
  14.                      ORIGINAL.XPC -  The Default settings for all of the Ships
  15.                      REGISTER.ME  -  Registation Form.
  16.  
  17.  
  18.                                 -= Features =-
  19.  
  20.   Complete facility to create/edit the Pilot Files.
  21.   Quick Recover of Pilots two different ways.
  22.   Complete facility to create/edit Missions Files.
  23.   Reads All three versions of XWING.
  24.   Support all Four tours that are out.
  25.   Almost Complete facility to edit Crafts.
  26.   The Ability to remove the Copy protection from XWING.
  27.   Menu Driven, and ESC aborts whatever you are doing.
  28.   Soon: Tour Editor(File Decoded), Briefing Editor (File Decoded).
  29.  
  30.  
  31.                            -= About the Author =-
  32.  
  33.   Currently I have only a few games I really Enjoy: WOLF-3D, XWING, Lemmings 2.
  34. Since their is already many great editors for WOLF3D, I decided to do one after
  35. looking at the editors that are out there. Most of them either were a pain to
  36. use, Buggy, or incomplete.
  37.  
  38.   I spent many, many, many hours deciphering the Pilot, Mission, Briefing, and
  39. select locations in other XWING files (The Briefing was the hardest).  There is
  40. very little I don't know about these files(See HELP), I have several programs I
  41. programmed in-house that I use to make sure that the files are deciphered
  42. correctly.  Also the "XWING Official Strategy Guide" was helpful by making sure
  43. that the first three TOD's were deciphered correctly. 
  44.  
  45.  
  46.                                 -= BUGS =-
  47.  
  48.    Hopefully you wont find any bugs, but if you manage to find a bug that I
  49. missed during the Beta Testing cycle, Please let me know via the addresses
  50. below.
  51.  
  52.  
  53.                               -= Shareware =-
  54.  
  55.   Since I spent so much time on this project (I never guessed it would take
  56. me this much time), I'm releasing it as shareware for $15. 
  57.  
  58.   What I've done to the shareware version is deactivated Tour 4+ editing, 
  59. Deactivated Mission Saving, and Removed the copy protection removal function.
  60. Otherwise it's fully working version of Xwing Pro.
  61.  
  62.  
  63.                             -= Letting Me Know =-
  64.  
  65. If you have any questions you can Mail me a letter via:
  66. U.S. Post Office     =  1997 Cluster Pine Rd.     Colton, Ca 92324-8400
  67. Software Creations   =  email "Nathan Anderson" at 1-508-368-7139
  68. The Prime Connection =  email "Nathan Anderson" at 1-909-274-9634
  69.  
  70.  
  71.                             -= Command Line =-
  72.  
  73.   XP can be started be a variety of ways.  Starting XP without any parameters,
  74. will start you in the main menu.  Starting XP with a '/P' or '-P' will stick
  75. place you in a listing of pilots that you can edit.  Starting XP with a '/M'
  76. will place you into a listing of Mission files.  Starting XP with a '/O' will
  77. stick you in the Other Menu.  Starting XP with a '/T' will stick you in the 
  78. TOD menu. Starting XP with a '/B' will stick you in the Briefing Listing.
  79. Starting XP with any of the above plus the name of the file will stick you
  80. in their respected editors.  Starting XP '-P' plus a file will open the
  81. file and check to see if the pilot is dead/captured if it is it will revive
  82. the pilot and quit to DOS. Otherwise it will stick you in the pilot editor.
  83. Starting XP '-E' plus a file will force XP to stick you in the pilot editor.
  84. And last but not least, XP *.PLT or XP NA?HAN?.PLT will revive all pilots 
  85. matching the wild cards.
  86.  
  87. Summary:
  88.   XP           - Main Menu
  89.   XP /P        - Pilot file Listing
  90.   XP /M        - Mission file Listings
  91.   XP /O        - Other Menu
  92.   XP /B        - Briefing file Listings                     <NOT AVAILABLE YET>
  93.   XP /T        - Tour of Duty file Listings                 <NOT AVAILABLE YET>
  94.   XP /A        - Applies a TOD file to XWING                <NOT AVAILABLE YET>
  95.   XP /P <NAME> - Checks if pilot is dead, if so revives pilot. If Not Edits.
  96.   XP /E <NAME> - Forces XP to Edit pilot.
  97.   XP /M <NAME> - Opens Mission file and Edits it.
  98.   XP /B <NAME> - Opens Briefing file and Edits it.          <NOT AVAILABLE YET>
  99.   XP /T <NAME> - Opens Tour of Duty file and edits it.      <NOT AVAILABLE YET>
  100.   XP /A <NAME> - Applies TOD file to XWING                  <NOT AVAILABLE YET>
  101.   XP *.PLT     - Revives all Dead Pilots
  102.   XP NAT?.PLT  - Revives all pilots matching the Wild cards.
  103.  
  104.  
  105.  
  106.                                  -= Main Menu =-
  107.  
  108.   The Main Menu will give you 6 choices, you may either move the cursor up/down
  109. or hit the first letter that's highlighted to select it.
  110.  
  111. Options:
  112.   P) Pilot Editor       - Will Stick you in the Pilot Listing
  113.   M) Mission Editor     - Will Stick you in the Mission Listing
  114.   B) Briefing Editor    - Will Stick you in the Briefing Listing
  115.   O) Other Xwing Stuff  - Will Stick you in the Other Menu
  116.   T) TOD Editor         - Will Stick you in the TOD Listing
  117.   ESC) Return to DOS    - Quits XP
  118.  
  119.  
  120.                                 -= Pilot Listing =-
  121.  
  122.   The Listings are probably one of my favorite things in XP, they display
  123. fifty file names in a list that you can choose one by using the cursor keys
  124. (Up/Down/Left/Right) and the <ENTER> to select one.  Upon selecting one
  125. you will be put into the Pilot Editor.
  126.   If there are more than fifty pilot files in the directory, another option
  127. will appear.  By hitting 'N' you will go to the next page of files or by
  128. hitting 'P' you will go to the prior Page.
  129.   Also available in the Pilot Listing is the 'R' command, it will revive a
  130. dead/Captured pilot (You may notice that the names are not all the same color,
  131. if a name is in red that means the pilot is captured, if in black it means the
  132. pilot is dead, otherwise the pilot is healthy.)
  133.   And Then you may also use '2' - Change to Mission Listing, '3' - Change to
  134. Briefing Listings.
  135.  
  136.  
  137.                              -= Mission Listings =-
  138.  
  139.   This listing acts the same way that the Pilot one does except for two things
  140. One is that there is no 'Revive command, and two is if you highlight a file
  141. that is a Original Xwing Mission (Tours 1-4) it bring up a window with the
  142. mission Full Name, Mission Tour Number, and Mission Number.
  143.  
  144.  
  145.                             -= Briefing Listings =-
  146.  
  147.   Identical to the Mission Listings.  Except that its for briefings.
  148.  
  149.  
  150.                               -= Other Menu =-
  151.  
  152.   This menu is very similar to the main menu except it has two new items.
  153. 1. Remove Copy Protection - Will Remove the Copy protection from Xwing, So far I
  154. can remove it from the three versions that I have (Original V1.0, Tour 4 V1.1,
  155. and Tour 4 V1.1a with bugs removed).  When the game asks you for the copy
  156. protection you just hit <ENTER>.
  157. 2. Edit Ships - This will allow you to edit the Ships attributes (Like Speed,
  158. Firepower, Shields, ect...).
  159.  
  160.  
  161.                              -= Pilot Editor =-
  162.  
  163.   Basically these menus are self explanatory, However I will point out one thing.
  164. the "2) Edit Tours" & "3) Edit Pilot by Tours" I implemented this system twice
  165. one by a menu and the second you scroll through the names of the tours/Missions.
  166.  
  167.  
  168.                     -= Mission Editor/Briefing Editor =-
  169.  
  170.   Basically you have on the Top part of the menu 16 Crafts (On the Left) and
  171. 16 Object (on the right), by hitting <ENTER> on any one you will go into
  172. their respected editor.  By Hitting <DELETE> you will delete one, and by
  173. hitting <ENTER> on a Unused spot you will add on.
  174.  
  175. NOTICE: Currently XP doesn't support the LEVEL?.XWI files, because they have
  176.         over 16 objects and have no crafts.
  177.  
  178.  
  179.                              -= Editing Ships =-
  180.  
  181.   Most of the Information is self explanatory, however the weapon racks are 
  182. sorta confusing, The ship can have a max number of 12 mounting racks for the
  183. energy and missile type weapons.  Basically the racks are were the guns are
  184. mounted on your craft, they also control how may guns you have.  If you have
  185. a Laser configured for racks 1-5, you will have 5 Lasers.  You can also put
  186. more than one weapon on a rack, You just map multiple weapons to the same
  187. group of racks.
  188.  
  189.   Notice: When you choose more than two energy guns they work but the display
  190.           of which weapon you are using seems to get corrupted.  Also when you
  191.           pick energy weapons for torpedoes you will see the same behavior.
  192.   Warning: Please make sure that if you are going to use any energy weapons
  193.            in the 3rd & 4th energy weapon spot, please have a weapon is slot 1.
  194.            Otherwise it may crash or do other weird things.
  195.  
  196.  
  197.  
  198.  
  199.                             -= Letting Me Know =-
  200.  
  201. If you have any questions you can Mail me a letter via:
  202. U.S. Post Office     =  1997 Cluster Pine Rd.     Colton, Ca 92324-8400
  203. Software Creations   =  email "Nathan Anderson" at 1-508-368-7139
  204. The Prime Connection =  email "Nathan Anderson" at 1-909-274-9634
  205.  
  206.  
  207.                                 -= Help =-
  208.  
  209. I'm willing to SWAP information on file formats, I currently don't know:
  210. Pilot File:   Locations 19-38
  211. Pilot File:   Locations 51-134  (I suspect it has to do with the PG's)   *
  212. Pilot File:   Locations 138-158 (I suspect it also has to do with PG's)  *
  213. Pilot File:   Locations 353-544 (I suspect it has to do with the HIST's) *
  214. Pilot File:   Locations 593-640 (I suspect it has to do with the HIST's) *
  215. Pilot File:   Locations 642-647
  216. Pilot File:   Locations 649-736
  217. Pilot File:   Locations 1561-1584
  218.  
  219. Mission File: Locations 7-8
  220. Mission File: Craft Locations  140-141
  221. Mission File: Haven't figured out the difference between Multi-Starts & Gotos
  222.               in the Cords system
  223. Mission File: Object Locations 48-49
  224. Mission File: Object Locations 64-69
  225.  
  226. Ship Editor Locations Starts at Start of Craft Info in File
  227. FLIGHT.OVL: Locations 36-39
  228. FLIGHT.OVL: Locations 46-47
  229. FLIGHT.OVL: Locations 50-51
  230. FLIGHT.OVL: Locations 56-61
  231. FLIGHT.OVL: Locations 66-69
  232. FLIGHT.OVL: Locations 92-98
  233. FLIGHT.OVL: Locations 105-107
  234. FLIGHT.OVL: Locations 204-224
  235.  
  236. * - I pretty sure what they do, but can't confirm (These locations I'm not
  237.     in need of, however any of the other spots I would love to find out)
  238.  
  239.